Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / sr.arc / SR.DOC < prev next >

Wrap

Text File | 1986-01-20 | 39.9 KB | 1,988 lines

STILL RIVER SHELL BOB HOWARD, P.O. BOX 57, STILL RIVER, MA 01467 617-456-3699 RE: Version 1.21 The enclosed program (SR.EXE) and documentation (SR.DOC) are for version 1.21 of the Still River Shell user supported software. If you have the prior version of the shell (version 1.19), please replace any old copies of the shell or its documentation with version 1.21. If this is your first copy of the shell, the following is a brief summary of the Still River Shell. The STILL RIVER SHELL is a powerful PC-DOS system utility providing an efficient and simple environment for file and directory management as well as a high performance command interface to DOS. The Still River Shell is an invaluable tool for all PC-DOS users from novice to professional: - Eliminate almost all command and filename typing. - Keep a stack of 20 of your prior DOS commands for instant recall, WP type command line edit and execution. - Scroll Up/Down through file and directory lists to select items for use in command execution. - Copy, move, delete and list files and directories with single keystroke command selection as well as automatic generation of command, file and directory names on your command line. - See realtime file, directory and disk information as you execute commands. - Locate files easily anywhere on your system. - Display graphically directory tree structures. - View the contents of any file. - Sort files by name, extension, size or date. - Protect against accidentally copying onto existing files. - Backup large directories onto multiple diskettes. - Define your own extensions to the Shell's command set. The Still River Shell runs on the IBM PC, XT & AT under PC-DOS versions 2.n and 3.n; occupies a minimum of 76K. Sincerely, Bob Howard Still River Shell User and Reference Guide Abridged Diskette Version 1.21 January 20, 1986 (c) Copyright Bob Howard 1986 All rights reserved. Still River Shell Table of Contents Chapter 1 License 3 1.1 Bearer License 3 1.2 User Support 3 1.3 Acknowledgments 3 Chapter 2 User Guide 4 2.1 The Still River Shell 4 2.2 Optional Performance Consideration 5 2.3 Futures 5 2.4 Note of Caution 5 2.5 Demonstration Session 7 2.5.1 Set Up 7 2.5.2 Initial Screen 8 2.5.3 Sample Operations 8 Chapter 3 Reference Guide: Command Summary 12 3.1 CHDIR 13 3.2 COPY 14 3.3 DELETE 16 3.4 FIND 17 3.5 INFO 18 3.6 LIST 19 3.7 MOVE 21 3.8 OPTIONS 23 3.9 RENAME 25 3.10 SORT 26 3.11 TREE 27 3.12 VIEW 28 3.13 WRITE 29 3.14 XDOS 30 3.15 <function_key> 32 Chapter 4 User Guide: Still River Shell Techniques 34 4.1 High Performance Option 34 4.2 Second Operand Selection 34 4.3 Restoring the Screen 35 4.4 Media Replacement 35 4.4.1 Insufficient Space 36 4.4.2 Change of System Default Drive Media 36 Still River Shell 4.5 Backup a Directory 36 4.6 Restore a Directory 37 4.7 Rename a Directory 37 4.8 Command <function_key> Usage 38 4.8.1 Print a File 38 4.8.2 Edit a File 39 4.8.3 Execute a File 39 4.8.4 Transmit a File 39 4.8.5 Backup the Set 39 4.8.6 Shell Help 40 4.8.7 FIND List <function_key> 40 4.8.8 Command Key Definition Standards 40 4.9 Saving and Using Shell File Lists 40 4.10 Hints For Using Hard Disks 41 4.10.1 Shared Logic Directory 41 4.10.2 Prevent Accidental Formatting 42 4.10.3 Improve Hard Disk Performance 42 4.11 Memory Usage 43 4.11.1 Nested Shell Calls 43 4.11.2 Out of Memory - Command Response 44 4.11.3 Memory Cost 45 Chapter 5 Reference Guide: Command Usage 46 5.1 Usage 46 5.1.1 Command Syntax 46 5.1.2 Command Window 46 5.1.3 Command Set 46 5.1.4 Command Selection 46 5.1.5 Command Edit 47 5.1.6 Command Execution 48 5.1.7 Command Response 48 5.1.8 Command Object Set 48 5.1.9 Command Extensions 48 5.1.9.1 Query 48 5.1.9.2 Media Replacement 49 5.1.9.3 Target File Protection 49 5.1.10 User Defined Commands 49 Chapter 6 Reference Guide: Window Definitions 51 6.1 Initial Command Selection Presentation 51 6.1.1 Set List Window 51 6.1.2 Data Window 51 Still River Shell 6.1.3 Command Window 52 6.2 FIND Presentation 53 6.2.1 Set List Window 53 6.2.2 Data Window 53 6.2.3 Command Window 54 6.3 TREE Presentation 54 6.3.1 Set List Window 54 6.3.2 Data Window 55 6.3.3 Command Window 56 6.4 Object Set List Window 56 Chapter 7 Reference Guide: Message Summary 57 7.1 Shell Informational Messages 57 7.2 Query Messages 59 Chapter 8 A Little Design Philosophy 61 Index Still River Shell License Chapter 1 License 1.1 Bearer License This abridged documentation is intended for diskette distribution with the Still River Shell program. You may copy and distribute this documentation as long as you make no change to the document or charge a fee beyond media and handling ($9 Max). See the INFO command in the shell program for information about obtaining the printed, unabridged documentation and the latest version of the program. 1.2 User Support If you use the shell, please help underwrite the cost of its development by sending us a small contribution. See the shell's INFO command to find out how to make a contribution which entitles you to program update notices and a credit towards orders of future versions. Your support now will help us continue our work and make future releases possible. 1.3 Acknowledgments Thanks to all who helped including the Boston Computer Society's PC Technical Group which supplied many of our Beta Testers and much needed encouragement. Almost all of the program was written using Lattice C. The documentation was prepared using The FinalWord word processor. - 3 - Still River Shell Introduction Chapter 2 User Guide 2.1 The Still River Shell The Still River Shell presents an enhanced PC-DOS environment. The shell allows the DOS user much greater efficiency than the standard DOS interface affords. Typical DOS functions of executing, finding, copying, moving, deleting and listing of files and directories can be done with significantly fewer key strokes when using the Still River Shell; recursive operations produce even greater efficiencies. And the shell provides a natural, intuitive interface which makes using DOS both more fun and more productive. You save a lot of work and time using the Still River Shell through the substantial elimination of command and operand typing. The shell allows you to use directly system information, such as file and directory lists, without having to copy the data from the screen and reenter it on your command line. You can select common commands without typing them. You can recall, edit and reenter DOS commands from the shell's prior DOS command stack. A powerful feature allows you to define your own extensions to the Still River Shell's command set. The Shell's full screen, real time presentation makes it an ideal system interface for mass storage systems such as the IBM/XT and IBM/AT. We could go on about the virtues of the shell, as we did in an earlier version of this document, but the best way to find out about the shell is to use it. The shell is designed to grow on you; you can use the shell productively right away while you learn about its other features. You may find it helpful to follow along during the demonstration session and to review briefly the commands in the reference guide. We hope you like the Still River Shell as much as we do. Remember, it is now your program too! Help support the Shell by sending your comments and contribution (see the INFO command). Thank you for your interest and support. - 4 - Still River Shell Introduction 2.2 Optional Performance Consideration The shell's performance, as well as that of many other programs, is much improved by instructing PC-DOS to keep a pool of IO Buffers numbering 14 or so. These buffers, used by DOS to speed up disk reads, are allocated by PC-DOS at "boot" time either by default or as specified in the CONFIG.SYS file. Either edit an existing CONFIG.SYS file or, if there is none, create a new one. The CONFIG.SYS file should be in the root directory (\). The CONFIG.SYS should read in part: BUFFERS=14 If you prepare that file now, we can BOOT under our new configuration. If you do not wish to do it now, try to remember to do it later. 2.3 Futures For every published work there comes a time when you have to say: "It's done" or at least "Version 1 is done". When, after two years of design and development, that time came for the Still River Shell, some of what we intended was not there. We hope to add, with your support, additional functions in the future. How the Shell develops in the future depends a great deal on the experiences and wishes of you, the shell user and supporter. Suggestions accompanied by contributions will be accorded the attention they deserve! In fact, it is you, the shell user, who will decide if there will be any future releases of the shell. We can not continue our work without your support. 2.4 Note of Caution The Still River Shell is a powerful system utility and you should take care when using it. While the shell has had significant design work to help insure proper operation as well as extensive - 5 - Still River Shell Introduction ALPHA and BETA testing to insure its proper execution, the shell, like all programs, can fail, or a user, like all users, can err. Operation of the shell is at the user's risk. - 6 - Still River Shell Introduction 2.5 Demonstration Session 2.5.1 Set Up Please prepare a diskette with only the Still River Shell (SR.EXE) on it; we will use this diskette as our practice area. Mount the diskette on Drive A. Now, select the system default drive and a directory with at least 25 files, the more the better, as the current default directory. You may do this when you start the shell by specifying: ?>A:SR C:\MYDIR start the shell (A:SR) select system default drive (C:) select system current directory (\MYDIR) - 7 - Still River Shell Demonstration Session 2.5.2 Initial Screen When the shell starts, it presents the initial screen. As you can see, there are three main areas, or windows, on the initial screen: ================================= | | | | | | | | | | | | | SET | DATA | | | | | | | | | | | | | ================================= | COMMAND | ================================= - Set List Window on the left is used to list the selected set of files and directories, <selected_set>. - Data Window on the right contains summary information about the <default_drive>, <selected_directory> and <selected_set> or other context sensitive data. - Command Window at the bottom of the screen is used to select and to enter commands as well as to receive responses and obtain help. 2.5.3 Sample Operations Now that you have the shell started, try the following shell operations: To copy a file from the <selected_set> to the practice diskette, perform the following steps: 1. You select a command by entering the letter, upper or lower case, equal to the upper case letter in the command name. In the case of COPY, <C>. The <selected_command> and the <selected_file> appear on the command input line in the Command Window. 2. Move the file <selector> with the <UP/DOWN CURSOR> keys to the file you wish to copy. Note: that the first operand on - 8 - Still River Shell Demonstration Session the command line changes as you move the <selector>. 3. Enter the <to_file> operand, in this case, <A:> 4. Enter <CR> to execute the command. To copy another file to A:, 1. Move the file <selector> to the file you wish to copy. 2. Enter <CR> to execute the copy. To copy some but not all files with a particular extension, e.a. <.BAT>: 1. Enter <ESC> to return to command selection. 2. Enter <S> to select sort. 3. Enter <E> to sort by extension. 4. Enter <ESC> to return to command selection. 5. Enter <C> to select copy. 6. Move the file <selector> to the first file with the desired extension. 7. Enter <A:> to set <to_file>. 8. Enter <CR> to execute the copy. 9. Move to the file <selector> to the next file to be copied. 10. Enter <CR> to execute the copy. 11. Repeat the last two steps until each file you wish to copy is copied. To edit the command line to copy all files of a specific extension, e.a. <.BAT> 1. Position the command line cursor at the first letter of the <from_file> in the command text. For example: COPY LAST.BAT A: ^ 2. Delete the first part of the filename by entering <DEL> until the <from_file> is deleted up to the period changing <LAST.BAT> to <.BAT>. - 9 - Still River Shell Demonstration Session 3. Enter <*> so the command line reads <COPY *.BAT A:>. 4. Enter <CR> to execute the copy. Note: the copy command places a list of the files copied in the Set List Window. 5. Enter <ESC> to return to command selection. To List a new current directory: 1. Enter <L> to select LIST function. 2. Enter <directory_name>. 3. Enter <CR> to execute the change directory and list all files in the new directory. To enter and execute a PC-DOS command: 1. Enter <X> to select the EXECUTE DOS command presentation. 2. Enter <DIR *.*><CR> to execute command under DOS. 3. Enter <DATE><CR> to execute command under DOS. 4. Respond to DATE with <CR>. To recall your prior DOS commands: 1. Enter the <UP CURSOR> twice. You should see the DATE command and then the DIR command. 2. Move the cursor to the first <*> and delete <*.*> with <DEL>. 3. Replace the deleted operand with the <selected_file> by entering <INS>. 4. Enter <CR> to execute the edited command line. 5. Enter <ESC> to return to command selection. To delete some of the files on a: 1. Enter <L> to select the LIST function. 2. Enter <A:> to select a new DOS default drive to A 3. Enter <CR> to change <default_drive>, list all files on <drive a:>'s current directory. 4. Move the file <selector> to the first file to be deleted. - 10 - Still River Shell Demonstration Session 5. Enter <D> to select the delete command. 6. Enter <CR> to delete the file. 7. Move the file <selector> to the next file you wish to delete. 8. Enter <CR> to delete the file. 9. Enter <ESC> to return to command selection. You are on your way! Try the TREE command next, it gives a nice visual presentation of your directory structure as well as allowing you to MAKE, REMOVE or LIST directories. Try all the commands. Watch out for DELETE and MOVE; they can delete files you may miss. - 11 - Still River Shell Command Summary Chapter 3 Reference Guide: Command Summary The following is a summary of the Still River Shell commands. - 12 - Still River Shell CHDIR 3.1 CHDIR Command CHDIR Function To change the current directory under the shell, use the LIST command or the LIST subcommand of the TREE command. Operand 1 Operation Options - 13 - Still River Shell COPY 3.2 COPY Command COPY <from_file_set> [<to_file_set>] [/Q]<CR> Function The COPY command copies the entire contents of the <from_file> creating a new <to_file>. Operand 1 <from_file_set> Any standard DOS file specification [<drive>:][\][<directory>\][<file_name>]. Operand 2 <to_file_set> Any standard DOS file specification or blank. Operation COPY FILEA FILEB Copies FILEA to FILEB in the current directory. COPY *.ASM \SAVE Copies all files in the current directory with an <.ASM> extension to the <\SAVE> directory. Should there be no more room on the target disk, the copy prompts: ^ insufficient space; retry on new disk? (y/n) If you change the disk and enter <Y>, the COPY will resume copying the <file_set> starting with the complete file that did not fit on the prior media. You may use as many media as you need to complete the <file_set> COPY. If you wish to concatenate files, use the DOS COPY command. 1 Options Option (1) Write on existing files ---------- 1. See the OPTION Command - 14 - Still River Shell COPY Option (3) or </Q> Query on multiple operations. - 15 - Still River Shell DELETE 3.3 DELETE Command DELETE <file_set> [/Q]<CR> Function The DELETE command deletes all files in the <file_set> specification. Operand 1 <file_set> Any standard DOS file specification [<drive>:][\][<directory>\][<file_name>]. Operation DELETE *.ASM Deletes files in the current directory with an <.ASM> extension. When a wild card, <*> or <?>, is used in the file name, the set of deleted files is presented in the Set Window. DELETE <selected_file> Deletes the highlighted, <selected_file> in the current set window. After the <selected_file> is deleted, an adjacent file is selected as the new <selected_file> in both the Set Window and the command line. Options Option (3) or </Q> Query on multiple operations. - 16 - Still River Shell FIND 3.4 FIND Command FIND <file_set><CR> Function The FIND command creates an ordered list (<drive>\<dir>\<file_name>) of all files within the <file_set>. Operand 1 <file_set> Any standard DOS file specification [<drive>:][\][<directory>\][<file_name>]. NOTE: Drive and directories can be specified with a wild card <?> or <*>. Operation FIND FILEA.BAT Lists any FILEA.BAT in any directory on the current drive. FIND C:*.* Finds all files in all directories on disk <C:>. FIND \DIR4\*.bat Finds all <.BAT> files in directory \DIR4. FIND \DIRX\*\*.BAT Finds all <.BAT> files in any subdirectory of the <DIRX> directory. FIND \*\CMD\*.BAT Finds all <.BAT> files in a <CMD> subdirectory of any parent directory. FIND *:*.* Finds all files on all drives from a to z. Options None. - 17 - Still River Shell INFO 3.5 INFO Command INFO Function The INFO command displays license information including our address, suggested contribution, credits and how to order the latest versions of the Still River Shell program and unabridged documentation. Operand 1 None. Operation Strike any key to see next page. Options None. - 18 - Still River Shell Commands User Guide: Other Still River Commands LIST The LIST command presents an ordered list of files and subdirectories from a <selected_directory> based on the <file_set> specification. In addition, the LIST command can change the system's default drive and current directory to a specified drive or directory. The <selected_directory> always becomes the system current directory when the LIST command executes. MOVE The MOVE command establishes the entire contents of the <from_file> under the identity of a new <to_file> name and deletes the <from_file>. OPTIONS The OPTIONS command shows and sets the values of shell system options. SORT The SORT command sorts the current <file_set> list and determines LIST sort criteria. TREE The TREE command displays both the parent and subdirectory structure of the <selected_directory>. In addition, you may "move" up and down the directory structure as well as LIST, MAKE or REMOVE a directory. VIEW The VIEW command displays the contents of a file in character format. WRITE The WRITE command copies the <selected_file_set> list, created by the LIST or FIND commands, to the <to_file>. XDOS The XDOS (execute DOS) command allows you to execute commands under DOS from the shell including prior command recall and full command line edit. <Fn> The <function_key> executes a command line under DOS including the state of the shell as parameters. (Details included in unabridged, printed documentation only) - 19 - Still River Shell Shell Techniques Chapter 4 User Guide: Still River Shell Techniques (Included in unabridged, printed documentation only) - 34 - Still River Shell Command Usage Chapter 5 Reference Guide: Command Usage (Included in unabridged, printed documentation only) - 46 - Still River Shell Window Definitions Chapter 6 Reference Guide: Window Definitions (Included in unabridged, printed documentation only) - 51 - Still River Shell Message Summary Chapter 7 Reference Guide: Message Summary (Included in unabridged, printed documentation only) - 57 - Still River Shell Design Philosophy Chapter 8 A Little Design Philosophy (Included in unabridged, printed documentation only) - 61 - Still River Shell Index /Q 24 <ALT> 32 <BACK SPACE> 47 <case>, <Fn> 32 <CR> 9, 47 <CTRL> 32 <CTRL>+<BACK SPACE> 47 <CTRL>+<K> 47 <default_drive> 8 <DEL> 47 <END> 47 <ESC> 9, 30, 47 <Fn> 32 <function_key> 32, 38 <function_key>, FIND 40 <function_key>, LIST 38 <HOME> 47 <INS> 47 <LEFT/RIGHT CURSOR> 46, 47 <object_set> 48 <object_set>, window 56 <PGDN> 47 <PGUP> 47 <selected_command> 8 <selected_directory> 19 <selected_file> 8 <selected_set> 8 <selector> 51 <SHIFT> 32 <UP/DOWN CURSOR> 10, 47 ATTR (attribute) 54 BACKUP 36 BUFFERS= 5 CHDIR 13 Command Line, edit 9, 47 Command Window 8 Command Window, FIND 54 Command Window, LIST 52 Command Window, TREE 56 Command, <function_key> 38 Command, <object_set> 48 Command, extensions 48 Command, key definition 40 Command, line clear 47 Command, query 48 Command, response 48 Still River Shell Command, selection 46, 51 Command, set 46 Command, summary 12 Command, syntax 46 Command, user defined 49 Command, window 46 CONFIG.SYS 5 COPY 8, 9, 14 COPY, directory backup 36 COPY, directory restore 37 COPY, file concatenation 14 COPY, insufficient memory 44 Data Window 8 Data Window, FIND 53 Data Window, LIST 51 Data Window, TREE 55 DELETE 10, 16 DELETE, insufficient memory 44 Demonstration Session 7 Directory, backup 36 Directory, rename 37 Directory, restore 37 Disk, performance 5, 42 Diskette, replacement 35, 49 DOS Command Interface 30 File, edit 39 File, execute 39 File, print 38 File, protection 49 File, transmit 39 FinalWord 3 FIND 17 FIND, <function_key> 40 FIND, insufficient memory 44 FIND, windows 53 formatting 42 Futures 5 Help 40 INFO 18 insufficient space 49 Lattice C 3 License 3 LIST 10, 19 List Window 8 LIST, <function_key> 38 List, saving 40 LIST, subcommand of TREE 27 LIST, windows 51 MAKE 27, 37 media replacement 49 Memory 43 Memory, out of 44 Messages, informational 57 Still River Shell Messages, query 59 MOVE 21, 34, 37 MOVE, insufficient memory 44 Nesting Calls 43 OPTIONS 23 PATH 31 PC-DOS 4 Printed Documentation 3 Printed Documentation, order 18 Query 48 REMOVE 27 RENAME 25 RENAME, directory 37 Sample Operations 8 Screen, restore 35 Second Operand, selection 34 Set List Window 51 Set List Window, FIND 53 Set List Window, LIST 51 Set List Window, TREE 54 shared logic 41 Shell Screen, organization 8 Shell, performance 5 SORT 26 SR.EXE 7 Starting the Shell 7 TREE 11, 27, 37 TREE, windows 54 UP/DOWN CURSOR 30 Update Notice 3 User Support 3 VIEW 28, 35 Window, FIND 53 Window, initial 51 Windows 8, 51 Windows, LIST 51 Windows, TREE 54 WRITE 29 XDOS 10, 30, 35 - 61 -